﻿// Copyright © 2015 onwards, Andrew Whewell
// All rights reserved.
//
// Redistribution and use of this software in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
//    * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
//    * Neither the name of the author nor the names of the program's contributors may be used to endorse or promote products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OF THE SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace VirtualRadar.Interface
{
    /// <summary>
    /// An enumeration of the different mechanisms that the BackgroundThreadQueue can use.
    /// </summary>
    public enum BackgroundThreadQueueMechanism
    {
        /// <summary>
        /// Items are processed one-at-a-time on the background thread. Stopping the queue will clear unprocessed items
        /// from the queue. Communication between the calling thread and background thread is via a WaitHandle.
        /// </summary>
        Queue,

        /// <summary>
        /// As per <see cref="Queue"/> but the background thread continuously polls the queue for more entries to process,
        /// relinquishing its time slice if there is nothing to process. This is only supported under Windows, when running
        /// on Mono this is translated into a <see cref="Queue"/>.
        /// </summary>
        QueueWithNoBlock,

        /// <summary>
        /// Forces all items to be processed on the thread that adds them. This is forced on internally during unit tests.
        /// </summary>
        SingleThread,

        /// <summary>
        /// Items are sent to the ThreadPool for processing, so they are processed in parallel. Stopping the queue will
        /// not stop processing of items that are queued on the ThreadPool. The creator of the queue can control how
        /// many items are processed in parallel.
        /// </summary>
        ThreadPool,
    }
}
